home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat1 / dtl2sgft.z / dtl2sgft
Text File  |  1998-10-20  |  9KB  |  199 lines
  1.  
  2.  
  3.  
  4. DDDDTTTTLLLL2222SSSSGGGGFFFFTTTT((((1111))))                                                        DDDDTTTTLLLL2222SSSSGGGGFFFFTTTT((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      dtl2sgft - Online Documentation Administration Utility for InfoSearch
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      dtl2sgft   -b bbbbooooooookkkk____nnnnaaaammmmeeee -s bbbbooooooookkkksssshhhheeeellllffff____ppppaaaatttthhhh
  13.               [ -a aaaauuuutttthhhhoooorrrriiiizzzzaaaattttiiiioooonnnn____ssssttttrrrriiiinnnngggg ] [ -d ddddaaaattttaaaa____ddddiiiirrrr ]
  14.               [ -o oooouuuuttttppppuuuutttt____ffffiiiilllleeee ] [ -p ] [ -q ggggrrrraaaannnnuuuullllaaaarrrriiiittttyyyy____qqqqrrrryyyy ]
  15.               [ -r rrrrooooooootttt ] [ -t ttttiiiittttlllleeee____ttttaaaagggg ] [ -u uuuusssseeee____sssshhhheeeellllffffnnnnaaaammmmeeee ]
  16.               [ -w ] [ -x ]
  17.  
  18.  
  19. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.      _d_t_l_2_s_g_f_t is a utility program used to assist in maintaining a full-text
  21.      searchable index of online books available to the _i_n_f_o_s_e_a_r_c_h(1)
  22.      application.
  23.  
  24.      For a specified _i_n_s_i_g_h_t(1) online book, _d_t_l_2_s_g_f_t builds a full-text
  25.      indexable word file which is an extraction of the content of the book.
  26.      This word file is used in conjunction with the _b_o_o_k_s_A_d_m_i_n(1) utility to
  27.      aid in constructing and maintaining a full-text index. Along with the
  28.      word file, a HTML-based version of the book's table of contents is also
  29.      produced.
  30.  
  31.      An administrator should never have to run this process by hand.  Normally
  32.      it will be launched by the _b_o_o_k_s_A_d_m_i_n(1) utility.  If it is run manually,
  33.      the only options required when processing _i_n_s_i_g_h_t(1) online books are ----bbbb
  34.      and ----ssss, as described below.
  35.  
  36.  
  37. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  38.      Command line options are described below.
  39.  
  40.      -b   The -b bbbbooooooookkkk____nnnnaaaammmmeeee required option tells _d_t_l_2_s_g_f_t to examine the
  41.           specified book.  The bbbbooooooookkkk____nnnnaaaammmmeeee is the abbreviated short title for
  42.           the book.  See _i_n_s_i_g_h_t(1) for more details on bookshelves.
  43.  
  44.      -s   The -s bbbbooooooookkkksssshhhheeeellllffff____ppppaaaatttthhhh required option tells _d_t_l_2_s_g_f_t which specific
  45.           bookshelf the bbbbooooooookkkk____nnnnaaaammmmeeee is on.  See _i_n_s_i_g_h_t(1) for more details on
  46.           bookshelves.
  47.  
  48.           For example,
  49.  
  50.           ddddttttllll2222ssssggggfffftttt ----bbbb IIIIRRRRIIIISSSSEEEEsssssssseeeennnnttttiiiiaaaallllssss ----ssss
  51.           ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////SSSSGGGGIIII____bbbbooooooookkkksssshhhheeeellllvvvveeeessss////SSSSGGGGIIII____EEEEnnnnddddUUUUsssseeeerrrr
  52.  
  53.      -a   The -a aaaauuuutttthhhhoooorrrriiiizzzzaaaattttiiiioooonnnn____ssssttttrrrriiiinnnngggg option instructs _d_t_l_2_s_g_f_t to use the
  54.           designated string as an authorization key for processing books that
  55.           have been licensed. This option is not be needed for the online
  56.           books from _S_i_l_i_c_o_n _G_r_a_p_h_i_c_s.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. DDDDTTTTLLLL2222SSSSGGGGFFFFTTTT((((1111))))                                                        DDDDTTTTLLLL2222SSSSGGGGFFFFTTTT((((1111))))
  71.  
  72.  
  73.  
  74.      -d   The -d ddddaaaattttaaaa____ddddiiiirrrr points to the default data directory. It should not
  75.           need to be set. The default is ////uuuussssrrrr////lllliiiibbbb////IIIInnnnssssiiiigggghhhhtttt////ddddaaaattttaaaa.
  76.  
  77.      -o   The -o oooouuuuttttppppuuuutttt____ffffiiiilllleeee option instructs _d_t_l_2_s_g_f_t to aaaappppppppeeeennnndddd the resultant
  78.           word file output to the specified oooouuuuttttppppuuuutttt____ffffiiiilllleeee. The HTML file for the
  79.           table of contents will still be created as:
  80.           bbbbooooooookkkksssshhhheeeellllffff____ppppaaaatttthhhh////bbbbooooooookkkkssss////bbbbooooooookkkk____nnnnaaaammmmeeee////bbbbooooooookkkk____nnnnaaaammmmeeee....hhhhttttmmmmllll.
  81.  
  82.      -p   The -p option instructs _d_t_l_2_s_g_f_t to purge or remove the word file it
  83.           creates (bbbbooooooookkkksssshhhheeeellllffff____ppppaaaatttthhhh////bbbbooooooookkkkssss////bbbbooooooookkkk____nnnnaaaammmmeeee////bbbbooooooookkkk____nnnnaaaammmmeeee....bbbbooooooookkkkssss....wwwwrrrrdddd). By
  84.           default, this file is not removed by _d_t_l_2_s_g_f_t.
  85.  
  86.      -q   The -q ggggrrrraaaannnnuuuullllaaaarrrriiiittttyyyy____qqqqrrrryyyy option indicates the level of granularity in
  87.           which to break up the book into. This should be specific to the SGML
  88.           instance (tag set) used within the book. For example, the default
  89.           is: "<INTRODUCTION> OR <PREFACE> OR <CHAPTER> OR <APPENDIX> OR
  90.           <GLOSSARY> OR <INDEX> OR <SGIINDEX>". If nothing is found for the
  91.           specified ggggrrrraaaannnnuuuullllaaaarrrriiiittttyyyy____qqqqrrrryyyy, there are two fallback attempts.  The
  92.           first uses "<SECTION1> OR <S1>" and the second utilizes the query
  93.           string "<SECTION2> OR <S2>".
  94.  
  95.      -r   The -r rrrrooooooootttt option instructs _d_t_l_2_s_g_f_t to write the resultant word
  96.           file and HTML file output to the specified rrrrooooooootttt directory.  For
  97.           example, for the specified rrrrooooooootttt, the resultant set of files are:
  98.           rrrrooooooootttt////bbbbooooooookkkk____nnnnaaaammmmeeee....bbbbooooooookkkkssss....wwwwrrrrdddd and rrrrooooooootttt////bbbbooooooookkkk____nnnnaaaammmmeeee....hhhhttttmmmmllll.
  99.  
  100.      -t   The -t ttttiiiittttlllleeee____ttttaaaagggg option indicates the SGML instance tag used to
  101.           designate titles within the content. The default is "TITLE".
  102.  
  103.      -u   The -u uuuusssseeee____sssshhhheeeellllffffnnnnaaaammmmeeee option instructs _d_t_l_2_s_g_f_t to use this string as
  104.           a bookshelf designation, both in the resultant word and HTML file.
  105.           The default is to use the end of the path string specified for
  106.           bbbbooooooookkkksssshhhheeeellllffff____ppppaaaatttthhhh. If
  107.           /usr/share/Insight/library/SGI_bookshelves/SGI_EndUser is specified
  108.           for bbbbooooooookkkksssshhhheeeellllffff____ppppaaaatttthhhh, the truncated string used to in the word and
  109.           HTML file is "SGI_EndUser". The -u uuuusssseeee____sssshhhheeeellllffffnnnnaaaammmmeeee option overrides
  110.           the aforementioned default.
  111.  
  112.      -w   The -w option instructs _d_t_l_2_s_g_f_t to only create a HTML-based table
  113.           of contents file for _web access.
  114.  
  115.      -x   The -x option instructs _d_t_l_2_s_g_f_t to output timing specifications.
  116.           By default, it runs silently.
  117.  
  118. FFFFIIIILLLLEEEESSSS
  119.      /usr/sbin/dtl2sgft
  120.  
  121. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  122.      _i_n_f_o_s_e_a_r_c_h(_1), _s_g_s_e_a_r_c_h(_1)
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. DDDDTTTTLLLL2222SSSSGGGGFFFFTTTT((((1111))))                                                        DDDDTTTTLLLL2222SSSSGGGGFFFFTTTT((((1111))))
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.                                                                         PPPPaaaaggggeeee 3333
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.